Updated azure queue docs to include the queue name #748
Conversation
Deploying contributing-docs with
|
| Latest commit: |
89b1ad5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8b333642.contributing-docs.pages.dev |
| Branch Preview URL: | https://smith-update-azure-queue-log.contributing-docs.pages.dev |
|
New Issues (1)Checkmarx found the following issues in this Pull Request
|
| - `globalSettings:events:connectionString` should not be set, or has the default value of | ||
| `UseDevelopmentStorage=true` | ||
| - `globalSettings:events:queueName` should be set to `"event"` |
There was a problem hiding this comment.
❓ Isn't there a default for this? And this is the legacy system we as Bitwarden no longer use, in favor of Rabbit of ASB.
There was a problem hiding this comment.
This change bitwarden/server@ed76fe2#diff-c7c5a77c5b7bba12d06b4ad31a2d0bb3bda535818183e8cce8aadfc7cb84e5f4R11-L13 removed the default queue
There was a problem hiding this comment.
The secrets example JSON updated and would cover this for compatibility reasons, but what I am not understanding is how this is used -- shouldn't the direct database writer for events be used?
There was a problem hiding this comment.
For anyone running pwsh setup_secrets.ps1, the updated secrets will now include the necessary configuration. However, I noticed this change because I still use Azure Queue locally. Since we now check for both globalSettings:events:connectionString and globalSettings:events:queueName:
if (CoreHelpers.SettingHasValue(globalSettings.Events.ConnectionString) &&
CoreHelpers.SettingHasValue(globalSettings.Events.QueueName))
{
services.TryAddSingleton<IEventWriteService, AzureQueueEventWriteService>();
return services;
}
Anyone still using Azure Queue who hasn't updated their secrets won't have AzureQueueEventWriteService registered, which would break their local event logging.
There was a problem hiding this comment.
I would prefer to break these engineers' local experiences in that case. We all need to upgrade. We almost outright removed the queueing logic altogether but left it in case someone in the field might.
There was a problem hiding this comment.
Oh that makes sense. I will close this PR then. Thanks.
🎟️ Tracking
📔 Objective
⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes